Skip to content

Fix remaining method signature issues across documentation#8185

Merged
dereuromark merged 2 commits into5.xfrom
fix-remaining-signatures
Jan 28, 2026
Merged

Fix remaining method signature issues across documentation#8185
dereuromark merged 2 commits into5.xfrom
fix-remaining-signatures

Conversation

@dereuromark
Copy link
Member

Summary

  • Fix malformed markdown syntax in table-objects.md (buildRules) and counter-cache.md (updateCounterCache) that was causing rendering issues
  • Add missing type annotations to ORM methods (save, findOrCreate, updateAll, deleteAll, Entity methods, ConnectionManager, TypeFactory)
  • Add parameter types to Controller methods (set, addViewClasses, fetchTable, fetchModel)
  • Add types to Response and CorsBuilder methods in request-response.md
  • Add types to ConsoleOptionParser methods in option-parsers.md
  • Add types to Helper callback methods and PaginatorHelper methods

Files Changed

  • docs/en/orm/table-objects.md - Fixed syntax error, added types to beforeRules, afterRules, TableLocator::get
  • docs/en/orm/behaviors/counter-cache.md - Fixed syntax error in updateCounterCache
  • docs/en/orm/database-basics.md - Added types to ConnectionManager::get, DateTimeType::setTimezone, TypeFactory::map
  • docs/en/orm/deleting-data.md - Added types to Table::deleteAll
  • docs/en/orm/entities.md - Added types to Entity::set, get, patch
  • docs/en/orm/saving-data.md - Added types to Table::save, findOrCreate, updateAll
  • docs/en/controllers.md - Added types to Controller::set, addViewClasses, fetchTable, fetchModel
  • docs/en/controllers/request-response.md - Added types to Response and CorsBuilder methods
  • docs/en/console-commands/option-parsers.md - Added types to ConsoleOptionParser methods
  • docs/en/views/helpers.md - Added types to Helper callback methods
  • docs/en/views/helpers/paginator.md - Added types to PaginatorHelper::sortDir, sortKey

Critical Fixes

Two syntax errors were causing malformed markdown rendering:

  1. table-objects.md:276: buildRules**()**(RulesCheckerbuildRules**(RulesChecker
  2. counter-cache.md:171: updateCounterCache**() with extra **() at end

Updated method signatures to include proper type annotations:
- app.md: className() parameter types
- collections.md: ~33 methods with full type annotations
- email.md: setAttachments(), setEmailPattern() types and return
- inflector.md: All 10 methods already had types (verified)
- number.md: setDefaultCurrency() static and nullable type
- text.md: transliterate(), toList() types (verified)
- time.md: setJsonEncodeFormat(), i18nFormat(), comparison methods
- xml.md: build(), toArray() types (verified)

Refs #7744
- Fix malformed markdown syntax in table-objects.md (buildRules) and
  counter-cache.md (updateCounterCache) causing rendering issues
- Add missing type annotations to ORM methods (save, findOrCreate,
  updateAll, deleteAll, Entity methods, ConnectionManager, TypeFactory)
- Add parameter types to Controller methods (set, addViewClasses,
  fetchTable, fetchModel)
- Add types to Response and CorsBuilder methods in request-response.md
- Add types to ConsoleOptionParser methods in option-parsers.md
- Add types to Helper callback methods and PaginatorHelper methods
@dereuromark dereuromark requested a review from josbeir January 28, 2026 16:29
@dereuromark dereuromark merged commit 0e83463 into 5.x Jan 28, 2026
5 checks passed
@dereuromark dereuromark deleted the fix-remaining-signatures branch January 28, 2026 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants